Creation information for an image. More...

#include <kanzi/gfx/create_info.hpp>

Inheritance diagram for kanzi::gfx::ImageCreateInfo:

Classes
struct	SliceInitialData
	Description of a single slice of initial data. More...

Public Types
using	HandleType
	Image handle.

Public Attributes
uint16_t	arraySize
	The size of the image array.

v3u32	dimensions
	The pixel dimensions of the image.

Format	format
	The pixel format of the image.

vector< SliceInitialData >	initialData
	Initial data for the image.

uint8_t	mipLevels
	The number of mip levels.

MultisampleCount	multisampleCount
	The number of samples for multisample anti-aliasing.

gfx::NativeTextureHandle	nativeHandleInfo
	Contains an optional external texture handle.

SwizzleMask	swizzleMask
	The swizzle mask used when sampling the image.

bool	takeNativeTextureHandleOwnership
	Should backend take a ownership of the native texture handle.

ImageType	type
	The image type.

ImageUsageFlag	usageFlag
	Expected usage of the image.

Public Attributes inherited from kanzi::gfx::BaseCreateInfo
string_view	name
	The name of the graphics object, useful for debugging.

Detailed Description

Creation information for an image.

An image contains pixel data that can be sampled by a shader.

Since: Kanzi 4.0.0

Member Typedef Documentation

◆ HandleType

using kanzi::gfx::ImageCreateInfo::HandleType

Image handle.

Member Data Documentation

◆ arraySize

uint16_t kanzi::gfx::ImageCreateInfo::arraySize

The size of the image array.

◆ format

Format kanzi::gfx::ImageCreateInfo::format

The pixel format of the image.

◆ dimensions

v3u32 kanzi::gfx::ImageCreateInfo::dimensions

The pixel dimensions of the image.

◆ usageFlag

ImageUsageFlag kanzi::gfx::ImageCreateInfo::usageFlag

Expected usage of the image.

◆ type

ImageType kanzi::gfx::ImageCreateInfo::type

The image type.

◆ mipLevels

uint8_t kanzi::gfx::ImageCreateInfo::mipLevels

The number of mip levels.

◆ multisampleCount

MultisampleCount kanzi::gfx::ImageCreateInfo::multisampleCount

The number of samples for multisample anti-aliasing.

◆ swizzleMask

SwizzleMask kanzi::gfx::ImageCreateInfo::swizzleMask

The swizzle mask used when sampling the image.

◆ initialData

vector<SliceInitialData> kanzi::gfx::ImageCreateInfo::initialData

Initial data for the image.

The local copy of this data is required only during the create function. The data is expected to be tightly packed with no padding between rows.

For Cubemap faces, the order is +X, -X, +Y, -Y, +Z, -Z.

◆ nativeHandleInfo

gfx::NativeTextureHandle kanzi::gfx::ImageCreateInfo::nativeHandleInfo

Contains an optional external texture handle.

When set the backend wraps the external handle instead of creating a new resource.

◆ takeNativeTextureHandleOwnership

bool kanzi::gfx::ImageCreateInfo::takeNativeTextureHandleOwnership

Should backend take a ownership of the native texture handle.

If ownership is taken then backend will try to free the native handle when image is freed.

The documentation for this struct was generated from the following file:

kanzi/gfx/create_info.hpp

Classes

Public Types

Public Attributes